Skip to content

docs: add pull request templates#223

Open
gbartolini wants to merge 2 commits into
mainfrom
docs/pr-templates
Open

docs: add pull request templates#223
gbartolini wants to merge 2 commits into
mainfrom
docs/pr-templates

Conversation

@gbartolini
Copy link
Copy Markdown
Contributor

Description

Adds GitHub pull request templates with contributor and maintainer checklists, derived from the lifecycle documented in CONTRIBUTING_NEW_EXTENSION.md.

Two templates live under .github/PULL_REQUEST_TEMPLATE/:

  • new_extension.md — full lifecycle checklist for adding a new extension: proposal link, package verification on trixie/bookworm, scaffolding, metadata.hcl/renovate/license gates, E2E, README examples, CODEOWNERS entry, and the maintenance commitment — plus a maintainer merge checklist (CI matrix, DCO, license compliance, Dockerfile/metadata.hcl review, Chainsaw tests).
  • default.md — lighter checklist for version bumps, fixes, shared tooling, and documentation changes; applied automatically by GitHub.

Since GitHub does not show a chooser for PR templates, the "Commit and Submit" section of CONTRIBUTING_NEW_EXTENSION.md now links to both templates via ?template= URLs.

Type of change

  • Documentation only

🤖 Generated with Claude Code

@gbartolini gbartolini requested review from a team and NiccoloFei as code owners May 29, 2026 05:02
gbartolini and others added 2 commits June 3, 2026 09:22
Add two GitHub PR templates with contributor and maintainer checklists:

- new_extension.md: full lifecycle checklist for adding a new extension
  (proposal link, package verification, scaffolding, metadata/renovate/license
  gates, E2E, README, CODEOWNERS and maintenance commitment).
- default.md: lighter checklist for version bumps, fixes, shared tooling and
  documentation changes; applied automatically by GitHub.

Reference both templates from the "Commit and Submit" section of
CONTRIBUTING_NEW_EXTENSION.md, since GitHub does not show a PR template chooser.

Assisted-by: Claude Opus 4.8
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
@NiccoloFei NiccoloFei force-pushed the docs/pr-templates branch from 48905d2 to 0d1dc57 Compare June 3, 2026 07:23
- [ ] Every component in the image is covered by a license on the
[CNCF Allowlist](https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md);
SPDX `licenses` in `metadata.hcl` are accurate.
- [ ] `task checks:all` passes locally.
Copy link
Copy Markdown
Contributor

@GabriFedi97 GabriFedi97 Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really required? It performs a local docker buildx bake --check for all the extensions

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is what CONTRIBUTING_NEW_EXTENSION.md says, though.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I think that's fine to be there as we are informing how to do local testing (even if it should just target the extension being proposed and not all), but once the PR is opened we probably should just rely on CI results.

[CNCF Allowlist](https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md);
SPDX `licenses` in `metadata.hcl` are accurate.
- [ ] `task checks:all` passes locally.
- [ ] Full E2E passes: `task e2e:test:full TARGET="<extension-name>"`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already covered by the CI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants